<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  <title>metisMenu - index</title>

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.min.css" />
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome/css/font-awesome.min.css">
  <link rel="stylesheet" href="assets/css/metisMenu.css" />
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs/themes/prism.css" />
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/animate.css" />
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/noty/lib/noty.css">
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/noty/lib/themes/relax.css">

  <link rel="stylesheet" href="assets/css/app.css">
  <link rel="stylesheet" href="assets/css/mm-vertical.css">

  <script src="https://cdn.jsdelivr.net/npm/jquery"></script>
  <script src="https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
  <script src="assets/js/metisMenu.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/prismjs"></script>
  <script src="https://cdn.jsdelivr.net/npm/noty"></script>

</head>

<body>

  <header>
    <nav class="navbar navbar-expand-lg navbar-light bg-light">
      <div class="container">
        <a class="navbar-brand" href="index.html">metisMenu</a>
        <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
          <span class="navbar-toggler-icon"></span>
        </button>
        <div class="collapse navbar-collapse" id="navbarSupportedContent">
          <ul class="navbar-nav ms-auto mb-2 mb-lg-0">
            <li class="nav-item dropdown">
              <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
                Examples
              </a>
              <ul class="dropdown-menu" aria-labelledby="navbarDropdown">
                <li>
                  <a class="dropdown-item" href="mm-vertical.html">Vertical Menu</a>
                </li>
                <li>

                <a class="dropdown-item" href="mm-horizontal.html">Horizontal Menu</a>
                </li>
                <li>

                <a class="dropdown-item" href="mm-folder.html">Folder View</a>
                </li>
                <li>

                <a class="dropdown-item" href="mm-vertical-hover.html">Hover Option For Desktop</a>
                </li>
                <li>
                  <a class="dropdown-item" href="mm-animate.html">Animate</a></li>
                  <li>

                  <a class="dropdown-item" href="mm-event.html">Event</a>
                  </li>
                  <li>

                  <a class="dropdown-item" href="mm-event2.html">Event 2</a>
                  </li>
                  <li>

                  <a class="dropdown-item" href="mm-dispose.html">Stop &amp; Start metisMenu</a>
                  </li>
                  <li>

                  <a class="dropdown-item" href="mm-ajax.html">Ajax</a>
                  </li>
                  <li>

                  <a class="dropdown-item" href="mm-faq.html">FAQ</a>
                  </li>
                  <li>

                  <a class="dropdown-item" href="mm-bs-card.html">Bootstrap Card</a>
                  </li>
                  <li>

                  <a class="dropdown-item" href="mm-docs.html">Docs</a>
                  </li>
              </ul>
            </li>


            <li class="nav-item dropdown">
              <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
                Templates
              </a>
              <ul class="dropdown-menu" aria-labelledby="navbarDropdown">
                <li>
                  <a class="dropdown-item" href="https://onokumus.com/chaldene" target="_blank">Chaldene Admin</a>
                </li>
                <li>

                  <a class="dropdown-item" href="https://onokumus.com/elektron" target="_blank">Elektron Admin</a>
                </li>
                <li>

                  <a class="dropdown-item" href="https://onokumus.com/twbuttons/" target="_blank">twbuttons</a>
                </li>
              </ul>
            </li>


            <li class="nav-item">
              <a class="nav-link" href="https://onokumus.com" target="_blank">onokumus</a>
            </li>
          </ul>
        </div>
      </div>
    </nav>
  </header>
  <div class="container">
    <script async defer src="https://buttons.github.io/buttons.js"></script>

    <section class="jumbotron text-center">
      <h1 class="jumbotron-heading">metisMenu</h1>
      <p class="lead text-muted">A collapsible jQuery menu plugin</p>
      <p>
        <a class="github-button" href="https://github.com/onokumus/metismenu" data-icon="octicon-star" data-size="large"
          data-show-count="true" aria-label="Star onokumus/metismenu on GitHub">Star</a>
        <a class="github-button" href="https://github.com/onokumus/metismenu/fork" data-icon="octicon-repo-forked"
          data-size="large" data-show-count="true" aria-label="Fork onokumus/metismenu on GitHub">Fork</a>
        <a class="github-button" href="https://github.com/onokumus/metismenu/archive/master.zip" data-icon="octicon-cloud-download"
          data-size="large" aria-label="Download onokumus/metismenu on GitHub">Download</a>
      </p>
      <p>
        <a href="https://www.npmjs.com/package/metismenu"><img src="https://img.shields.io/npm/v/metismenu.svg?style=flat"
            alt="NPM version"></a>
        <a href="https://npmjs.org/package/metismenu"><img src="https://img.shields.io/npm/dm/metismenu.svg?style=flat"
            alt="NPM monthly downloads"></a>
        <a href="https://npmjs.org/package/metismenu"><img src="https://img.shields.io/npm/dt/metismenu.svg?style=flat"
            alt="NPM total downloads"></a>
        <a href="https://travis-ci.org/onokumus/metismenu"><img src="https://img.shields.io/travis/onokumus/metismenu.svg?style=flat&amp;label=Travis"
            alt="Linux Build Status"></a>
        <a href="https://www.jsdelivr.com/package/npm/metismenu"><img src="https://data.jsdelivr.com/v1/package/npm/metismenu/badge"
            alt=""></a>
        <a href="https://packagist.org/packages/onokumus/metismenu"><img src="https://img.shields.io/packagist/v/onokumus/metismenu.svg"
            alt="Packagist"></a>
      </p>
    </section>
    <div class="row">
      <div class="col-md-3 mb-3">
        <nav class="sidebar-nav border">
          <ul id="toc">
            <li>
              <a href="#" class="has-arrow">Getting started</a>
              <ul>
                <li><a href="#install">Install</a></li>
                <li><a href="#download">Download</a></li>
              </ul>
            </li>
            <li><a href="#" class="has-arrow">Usage</a>
              <ul>
                <li><a href="#stopping-list-opening-on-certain-elements">Stopping list opening on certain elements</a></li>
              </ul>
            </li>
            <li><a href="#" class="has-arrow">Options</a>
              <ul>
                <li><a href="#toggle">toggle</a></li>
                <li><a href="#dispose">dispose</a></li>
                <li><a href="#preventdefault">preventDefault</a></li>
                <li><a href="#triggerelement">triggerElement</a></li>
                <li><a href="#parenttrigger">parentTrigger</a></li>
                <li><a href="#submenu">subMenu</a></li>
              </ul>
            </li>
            <li><a href="#events">Events</a></li>
            <li><a href="#migrating-to-v3-from-v2">Migrating to v3 from v2</a></li>
            <li><a href="#" class="has-arrow">About</a>
              <ul>
                <li><a href="#related-projects">Related projects</a></li>
                <li><a href="#contributors">Contributors</a></li>
                <li><a href="#contributing">Contributing</a></li>
                <li><a href="#release-history">Release History</a></li>
                <li><a href="#author">Author</a></li>
                <li><a href="#license">License</a></li>
              </ul>
            </li>
          </ul>
        </nav>

      </div>
      <div class="col-md-9 mb-3">
        <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
          <symbol id="check-circle-fill" fill="currentColor" viewBox="0 0 16 16">
            <path d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zm-3.97-3.03a.75.75 0 0 0-1.08.022L7.477 9.417 5.384 7.323a.75.75 0 0 0-1.06 1.06L6.97 11.03a.75.75 0 0 0 1.079-.02l3.992-4.99a.75.75 0 0 0-.01-1.05z"/>
          </symbol>
          <symbol id="info-fill" fill="currentColor" viewBox="0 0 16 16">
            <path d="M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194 0 .487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703 0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 1 1 0-2 1 1 0 0 1 0 2z"/>
          </symbol>
          <symbol id="exclamation-triangle-fill" fill="currentColor" viewBox="0 0 16 16">
            <path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5zm.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2z"/>
          </symbol>
        </svg>

        <div class="alert alert-warning d-flex align-items-center" role="alert">
          <svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="Warning:"><use xlink:href="#exclamation-triangle-fill"/></svg>
          <div>
            This version does not support any version of IE browser.
          </div>
        </div>
        <h2>Getting started</h2>
        <h3 id="install">Install</h3>
        <p>Install with <a href="https://www.npmjs.com/">npm</a>:</p>
        <pre><code class="lang-sh">npm install--save metismenu</code></pre>
        <p>Install with <a href="https://yarnpkg.com">yarn</a>:</p>
        <pre><code class="lang-sh">yarn add metismenu</code></pre>
        <p>Install with <a href="https://getcomposer.org/">composer</a></p>
        <pre><code class="lang-sh">composer require onokumus/metismenu:dev-master</code></pre>
        <h3 id="download">Download</h3>
        <p><a class="btn btn-info" href="https://github.com/onokumus/metisMenu/archive/master.zip">Download</a></p>
        <h2 id="usage">Usage</h2>
        <ol>
          <li>
            <p>Include metismenu StyleSheet</p>
            <pre><code class="lang-html">&lt;link rel="stylesheet" href="https://unpkg.com/metismenu/dist/metisMenu.min.css"&gt;
&lt;!-- OR --&gt;
&lt;link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/metismenu/dist/metisMenu.min.css"&gt;</code></pre>
          </li>
          <li>
            <p>Include jQuery</p>
            <pre><code class="lang-html">&lt;script src="https://unpkg.com/jquery"&gt;&lt;/script&gt;
&lt;!-- OR --&gt;
&lt;script src="https://cdn.jsdelivr.net/npm/jquery"&gt;&lt;/script&gt;</code></pre>
          </li>
          <li>
            <p>Include metisMenu plugin's code</p>
            <pre><code class="lang-html">&lt;script src="https://unpkg.com/metismenu"&gt;&lt;/script&gt;
&lt;!-- OR --&gt;
&lt;script src="https://cdn.jsdelivr.net/npm/metismenu"&gt;&lt;/script&gt;</code></pre>
          </li>
          <li>
            <p>Add id attribute to unordered list</p>
            <pre><code class="lang-html">&lt;ul id="metismenu"&gt;

&lt;/ul&gt;</code></pre>
          </li>
          <li>
            <p>Make expand/collapse controls accessible</p>
            <blockquote>
              <p>Be sure to add <code>aria-expanded</code> to the element <code>a</code>. This attribute explicitly defines
                the current state of the collapsible element to screen readers and similar assistive technologies. If the
                collapsible element is closed by default, it should have a value of <code>aria-expanded=&quot;false&quot;</code>.
                If you&#39;ve set the collapsible element&#39;s parent <code>li</code> element to be open by default using
                the <code>mm-active</code> class, set <code>aria-expanded=&quot;true&quot;</code> on the control instead.
                The plugin will automatically toggle this attribute based on whether or not the collapsible element has
                been opened or closed.</p>
            </blockquote>
            <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>&gt;</span>
             <span class="hljs-tag">&lt;<span class="hljs-name">li</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"mm-active"</span>&gt;</span>
               <span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"true"</span>&gt;</span>Menu 1<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
               <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
               ...
               <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
             <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
             <span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
               <span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"false"</span>&gt;</span>Menu 2<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
               <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
               ...
               <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
             <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
             ...
             <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
            </code></pre>
          </li>
          <li>
            <p>Arrow Options</p>
            <blockquote>
              <p>add <code>has-arrow</code> class to <code>a</code> element</p>
            </blockquote>
            <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ul</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"metismenu"</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">li</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"mm-active"</span>&gt;</span>
             <span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"has-arrow"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"true"</span>&gt;</span>Menu 1<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
             <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
             ...
             <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
            <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
            <span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
             <span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"has-arrow"</span> <span class="hljs-attr">href</span>=<span class="hljs-string">"#"</span> <span class="hljs-attr">aria-expanded</span>=<span class="hljs-string">"false"</span>&gt;</span>Menu 2<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
             <span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
             ...
             <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
            <span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
            ...
            <span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
            </code></pre>
          </li>
          <li>
            <p>Call the plugin:</p>
            <pre><code class="lang-javascript">$("#metismenu").metisMenu();</code></pre>
          </li>
        </ol>
        <h3 id="stopping-list-opening-on-certain-elements">Stopping list opening on certain elements</h3>
        <p>Setting aria-disabled=&quot;true&quot; in the <code>&lt;a&gt;</code> element as shown will stop metisMenu
          opening the menu for that particular list. This can be changed dynamically and will be obeyed correctly:</p>
        <pre><code class="lang-html">&lt;a href"#" aria-expanded="false" aria-disabled="true"&gt;List 1&lt;/a&gt;</code></pre>
        <h2 id="options">Options</h2>
        <h4 id="toggle">toggle</h4>
        <p>Type: <code>Boolean</code>
          Default: <code>true</code></p>
        <p>For auto collapse support.</p>
        <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu({
               <span class="hljs-symbol">toggle:</span> <span class="hljs-keyword">false</span>
             });
            </code></pre>
        <h4 id="dispose">dispose</h4>
        <p>Type: <code>String</code>
          Default: <code>null</code></p>
        <p>For stop and destroy metisMenu.</p>
        <pre><code class="lang-javascript"> <span class="hljs-variable">$(</span><span class="hljs-string">"#metismenu"</span>).metisMenu(<span class="hljs-string">'dispose'</span>);
            </code></pre>
        <h4 id="preventdefault">preventDefault</h4>
        <p>Type: <code>Boolean</code>
          Default: <code>true</code></p>
        <blockquote>
          <p>Prevents or allows dropdowns&#39; onclick events after expanding/collapsing.</p>
        </blockquote>
        <pre><code class="lang-javascript">   <span class="hljs-variable">$(</span><span class="hljs-string">"#menu"</span>).metisMenu({
                 <span class="hljs-symbol">preventDefault:</span> <span class="hljs-keyword">false</span>
               });
            </code></pre>
        <p><em>since from version 2.7.0</em></p>
        <h4 id="triggerelement">triggerElement</h4>
        <p>Type: <code>jQuery selector</code>
          Default: <code>a</code></p>
        <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
               triggerElement: <span class="hljs-string">'.nav-link'</span> <span class="hljs-comment">// bootstrap 4</span>
             });
            </code></pre>
        <h4 id="parenttrigger">parentTrigger</h4>
        <p>Type: <code>jQuery selector</code>
          Default: <code>li</code></p>
        <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
               parentTrigger: <span class="hljs-string">'.nav-item'</span> <span class="hljs-comment">// bootstrap 4</span>
             });
            </code></pre>
        <h4 id="submenu">subMenu</h4>
        <p>Type: <code>jQuery selector</code>
          Default: <code>ul</code></p>
        <pre><code class="lang-javascript"> <span class="hljs-symbol">$</span>(<span class="hljs-string">"#metismenu"</span>).metisMenu({
               subMenu: <span class="hljs-string">'.nav.flex-column'</span> <span class="hljs-comment">// bootstrap 4</span>
             });
            </code></pre>
        <h2 id="events">Events</h2>
        <table class="table table-bordered">
          <thead>
            <tr>
              <th scope="col">Event Type</th>
              <th scope="col">Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>show.metisMenu</td>
              <td>This event fires immediately when the <code>_show</code> instance method is called.</td>
            </tr>
            <tr>
              <td>shown.metisMenu</td>
              <td>This event is fired when a collapse <code>ul</code> element has been made visible to the user (will wait
                for CSS transitions to complete).</td>
            </tr>
            <tr>
              <td>hide.metisMenu</td>
              <td>This event is fired immediately when the <code>_hide</code> method has been called.</td>
            </tr>
            <tr>
              <td>hidden.metisMenu</td>
              <td>This event is fired when a collapse <code>ul</code> element has been hidden from the user (will wait for
                CSS transitions to complete).</td>
            </tr>
          </tbody>
        </table>
        <h2 id="migrating-to-v3-from-v2">Migrating to v3 from v2</h2>
        <ul>
          <li>Update <code>metisMenu.js</code> &amp; <code>metisMenu.css</code> files</li>
          <li>Change <code>active</code> class to <code>mm-active</code></li>
        </ul>


        <h3>Author</h3>
        <p><strong>Osman Nuri Okumus</strong></p>
        <ul>
          <li><a href="https://github.com/onokumus">github/onokumus</a></li>
          <li><a href="https://twitter.com/onokumus">twitter/onokumus</a></li>
        </ul>
        <h3>License</h3>
        <p>Copyright © 2018, <a href="https://github.com/onokumus">Osman Nuri Okumus</a>.<br>
          Released under the <a href="LICENSE">MIT License</a>.</p>
      </div>
    </div>


  </div>
<script>
  $(function () {
        $('#toc').metisMenu();
      });
</script>
</body>

</html>
